home *** CD-ROM | disk | FTP | other *** search
/ Games of Daze / Infomagic - Games of Daze (Summer 1995) (Disc 1 of 2).iso / djgpp / src / gdb-4.12 / gdb / symtab.h < prev    next >
Encoding:
C/C++ Source or Header  |  1994-02-03  |  36.1 KB  |  1,153 lines

  1. /* Symbol table definitions for GDB.
  2.    Copyright 1986, 1989, 1991, 1992, 1993, 1994 Free Software Foundation, Inc.
  3.  
  4. This file is part of GDB.
  5.  
  6. This program is free software; you can redistribute it and/or modify
  7. it under the terms of the GNU General Public License as published by
  8. the Free Software Foundation; either version 2 of the License, or
  9. (at your option) any later version.
  10.  
  11. This program is distributed in the hope that it will be useful,
  12. but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14. GNU General Public License for more details.
  15.  
  16. You should have received a copy of the GNU General Public License
  17. along with this program; if not, write to the Free Software
  18. Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19.  
  20. #if !defined (SYMTAB_H)
  21. #define SYMTAB_H 1
  22.  
  23. /* Some definitions and declarations to go with use of obstacks.  */
  24.  
  25. #include "obstack.h"
  26. #define obstack_chunk_alloc xmalloc
  27. #define obstack_chunk_free free
  28.  
  29. /* GNU C supports enums that are bitfields.  Some old compilers don't. */
  30. #if defined(__GNUC__) && !defined(BYTE_BITFIELD)
  31. #define    BYTE_BITFIELD    :8;
  32. #else
  33. #define    BYTE_BITFIELD    /*nothing*/
  34. #endif
  35.  
  36. /* Define a structure for the information that is common to all symbol types,
  37.    including minimal symbols, partial symbols, and full symbols.  In a
  38.    multilanguage environment, some language specific information may need to
  39.    be recorded along with each symbol.
  40.  
  41.    These fields are ordered to encourage good packing, since we frequently
  42.    have tens or hundreds of thousands of these.  */
  43.  
  44. struct general_symbol_info
  45. {
  46.   /* Name of the symbol.  This is a required field.  Storage for the name is
  47.      allocated on the psymbol_obstack or symbol_obstack for the associated
  48.      objfile. */
  49.  
  50.   char *name;
  51.  
  52.   /* Value of the symbol.  Which member of this union to use, and what
  53.      it means, depends on what kind of symbol this is and its
  54.      SYMBOL_CLASS.  See comments there for more details.  All of these
  55.      are in host byte order (though what they point to might be in
  56.      target byte order, e.g. LOC_CONST_BYTES).  */
  57.  
  58.   union
  59.     {
  60.       long value;
  61.  
  62.       struct block *block;
  63.  
  64.       char *bytes;
  65.  
  66.       CORE_ADDR address;
  67.  
  68.       /* for opaque typedef struct chain */
  69.  
  70.       struct symbol *chain;
  71.     }
  72.   value;
  73.  
  74.   /* Since one and only one language can apply, wrap the language specific
  75.      information inside a union. */
  76.  
  77.   union
  78.     {
  79.       struct cplus_specific      /* For C++ */
  80.     {
  81.       char *demangled_name;
  82.     } cplus_specific;
  83.       struct chill_specific      /* For Chill */
  84.     {
  85.       char *demangled_name;
  86.     } chill_specific;
  87.     } language_specific;
  88.  
  89.   /* Record the source code language that applies to this symbol.
  90.      This is used to select one of the fields from the language specific
  91.      union above. */
  92.  
  93.   enum language language BYTE_BITFIELD;
  94.  
  95.   /* Which section is this symbol in?  This is an index into
  96.      section_offsets for this objfile.  Negative means that the symbol
  97.      does not get relocated relative to a section.
  98.      Disclaimer: currently this is just used for xcoff, so don't
  99.      expect all symbol-reading code to set it correctly (the ELF code
  100.      also tries to set it correctly).  */
  101.  
  102.   short section;
  103. };
  104.  
  105. #define SYMBOL_NAME(symbol)        (symbol)->ginfo.name
  106. #define SYMBOL_VALUE(symbol)        (symbol)->ginfo.value.value
  107. #define SYMBOL_VALUE_ADDRESS(symbol)    (symbol)->ginfo.value.address
  108. #define SYMBOL_VALUE_BYTES(symbol)    (symbol)->ginfo.value.bytes
  109. #define SYMBOL_BLOCK_VALUE(symbol)    (symbol)->ginfo.value.block
  110. #define SYMBOL_VALUE_CHAIN(symbol)    (symbol)->ginfo.value.chain
  111. #define SYMBOL_LANGUAGE(symbol)        (symbol)->ginfo.language
  112. #define SYMBOL_SECTION(symbol)        (symbol)->ginfo.section
  113.  
  114. #define SYMBOL_CPLUS_DEMANGLED_NAME(symbol)    \
  115.   (symbol)->ginfo.language_specific.cplus_specific.demangled_name
  116.  
  117.  
  118. extern int demangle;    /* We reference it, so go ahead and declare it. */
  119.  
  120. /* Macro that initializes the language dependent portion of a symbol
  121.    depending upon the language for the symbol. */
  122.  
  123. #define SYMBOL_INIT_LANGUAGE_SPECIFIC(symbol,language)            \
  124.   do {                                    \
  125.     SYMBOL_LANGUAGE (symbol) = language;                \
  126.     if (SYMBOL_LANGUAGE (symbol) == language_cplus)            \
  127.       {                                    \
  128.     SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL;            \
  129.       }                                    \
  130.     else if (SYMBOL_LANGUAGE (symbol) == language_chill)        \
  131.       {                                    \
  132.     SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL;            \
  133.       }                                    \
  134.     else                                \
  135.       {                                    \
  136.     memset (&(symbol)->ginfo.language_specific, 0,            \
  137.         sizeof ((symbol)->ginfo.language_specific));        \
  138.       }                                    \
  139.   } while (0)
  140.  
  141. /* Macro that attempts to initialize the demangled name for a symbol,
  142.    based on the language of that symbol.  If the language is set to
  143.    language_auto, it will attempt to find any demangling algorithm
  144.    that works and then set the language appropriately.  If no demangling
  145.    of any kind is found, the language is set back to language_unknown,
  146.    so we can avoid doing this work again the next time we encounter
  147.    the symbol.  Any required space to store the name is obtained from the
  148.    specified obstack. */
  149.  
  150. #define SYMBOL_INIT_DEMANGLED_NAME(symbol,obstack)            \
  151.   do {                                    \
  152.     char *demangled = NULL;                        \
  153.     if (SYMBOL_LANGUAGE (symbol) == language_cplus            \
  154.     || SYMBOL_LANGUAGE (symbol) == language_auto)            \
  155.       {                                    \
  156.     demangled =                            \
  157.       cplus_demangle (SYMBOL_NAME (symbol), DMGL_PARAMS | DMGL_ANSI);\
  158.     if (demangled != NULL)                        \
  159.       {                                \
  160.         SYMBOL_LANGUAGE (symbol) = language_cplus;            \
  161.         SYMBOL_CPLUS_DEMANGLED_NAME (symbol) =             \
  162.           obsavestring (demangled, strlen (demangled), (obstack));    \
  163.         free (demangled);                        \
  164.       }                                \
  165.     else                                \
  166.       {                                \
  167.         SYMBOL_CPLUS_DEMANGLED_NAME (symbol) = NULL;        \
  168.       }                                \
  169.       }                                    \
  170.     if (demangled == NULL                        \
  171.     && (SYMBOL_LANGUAGE (symbol) == language_chill            \
  172.         || SYMBOL_LANGUAGE (symbol) == language_auto))        \
  173.       {                                    \
  174.     demangled =                            \
  175.       chill_demangle (SYMBOL_NAME (symbol));            \
  176.     if (demangled != NULL)                        \
  177.       {                                \
  178.         SYMBOL_LANGUAGE (symbol) = language_chill;            \
  179.         SYMBOL_CHILL_DEMANGLED_NAME (symbol) =             \
  180.           obsavestring (demangled, strlen (demangled), (obstack));    \
  181.         free (demangled);                        \
  182.       }                                \
  183.     else                                \
  184.       {                                \
  185.         SYMBOL_CHILL_DEMANGLED_NAME (symbol) = NULL;        \
  186.       }                                \
  187.       }                                    \
  188.     if (SYMBOL_LANGUAGE (symbol) == language_auto)            \
  189.       {                                    \
  190.     SYMBOL_LANGUAGE (symbol) = language_unknown;            \
  191.       }                                    \
  192.   } while (0)
  193.  
  194. /* Macro that returns the demangled name for a symbol based on the language
  195.    for that symbol.  If no demangled name exists, returns NULL. */
  196.  
  197. #define SYMBOL_DEMANGLED_NAME(symbol)                    \
  198.   (SYMBOL_LANGUAGE (symbol) == language_cplus                \
  199.    ? SYMBOL_CPLUS_DEMANGLED_NAME (symbol)                \
  200.    : (SYMBOL_LANGUAGE (symbol) == language_chill            \
  201.       ? SYMBOL_CHILL_DEMANGLED_NAME (symbol)                \
  202.       : NULL))
  203.  
  204. #define SYMBOL_CHILL_DEMANGLED_NAME(symbol)                \
  205.   (symbol)->ginfo.language_specific.chill_specific.demangled_name
  206.  
  207. /* Macro that returns the "natural source name" of a symbol.  In C++ this is
  208.    the "demangled" form of the name if demangle is on and the "mangled" form
  209.    of the name if demangle is off.  In other languages this is just the
  210.    symbol name.  The result should never be NULL. */
  211.  
  212. #define SYMBOL_SOURCE_NAME(symbol)                    \
  213.   (demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL            \
  214.    ? SYMBOL_DEMANGLED_NAME (symbol)                    \
  215.    : SYMBOL_NAME (symbol))
  216.  
  217. /* Macro that returns the "natural assembly name" of a symbol.  In C++ this is
  218.    the "mangled" form of the name if demangle is off, or if demangle is on and
  219.    asm_demangle is off.  Otherwise if asm_demangle is on it is the "demangled"
  220.    form.  In other languages this is just the symbol name.  The result should
  221.    never be NULL. */
  222.  
  223. #define SYMBOL_LINKAGE_NAME(symbol)                    \
  224.   (demangle && asm_demangle && SYMBOL_DEMANGLED_NAME (symbol) != NULL    \
  225.    ? SYMBOL_DEMANGLED_NAME (symbol)                    \
  226.    : SYMBOL_NAME (symbol))
  227.  
  228. /* From utils.c.  */
  229. extern int demangle;
  230. extern int asm_demangle;
  231.  
  232. /* Macro that tests a symbol for a match against a specified name string.
  233.    First test the unencoded name, then looks for and test a C++ encoded
  234.    name if it exists.  Note that whitespace is ignored while attempting to
  235.    match a C++ encoded name, so that "foo::bar(int,long)" is the same as
  236.    "foo :: bar (int, long)".
  237.    Evaluates to zero if the match fails, or nonzero if it succeeds. */
  238.  
  239. #define SYMBOL_MATCHES_NAME(symbol, name)                \
  240.   (STREQ (SYMBOL_NAME (symbol), (name))                    \
  241.    || (SYMBOL_DEMANGLED_NAME (symbol) != NULL                \
  242.        && strcmp_iw (SYMBOL_DEMANGLED_NAME (symbol), (name)) == 0))
  243.    
  244. /* Macro that tests a symbol for an re-match against the last compiled regular
  245.    expression.  First test the unencoded name, then look for and test a C++
  246.    encoded name if it exists.
  247.    Evaluates to zero if the match fails, or nonzero if it succeeds. */
  248.  
  249. #define SYMBOL_MATCHES_REGEXP(symbol)                    \
  250.   (re_exec (SYMBOL_NAME (symbol)) != 0                    \
  251.    || (SYMBOL_DEMANGLED_NAME (symbol) != NULL                \
  252.        && re_exec (SYMBOL_DEMANGLED_NAME (symbol)) != 0))
  253.    
  254. /* Define a simple structure used to hold some very basic information about
  255.    all defined global symbols (text, data, bss, abs, etc).  The only required
  256.    information is the general_symbol_info.
  257.  
  258.    In many cases, even if a file was compiled with no special options for
  259.    debugging at all, as long as was not stripped it will contain sufficient
  260.    information to build a useful minimal symbol table using this structure.
  261.    Even when a file contains enough debugging information to build a full
  262.    symbol table, these minimal symbols are still useful for quickly mapping
  263.    between names and addresses, and vice versa.  They are also sometimes
  264.    used to figure out what full symbol table entries need to be read in. */
  265.  
  266. struct minimal_symbol
  267. {
  268.  
  269.   /* The general symbol info required for all types of symbols.
  270.  
  271.      The SYMBOL_VALUE_ADDRESS contains the address that this symbol
  272.      corresponds to.  */
  273.  
  274.   struct general_symbol_info ginfo;
  275.  
  276.   /* The info field is available for caching machine-specific information that
  277.      The AMD 29000 tdep.c uses it to remember things it has decoded from the
  278.      instructions in the function header, so it doesn't have to rederive the
  279.      info constantly (over a serial line).  It is initialized to zero and
  280.      stays that way until target-dependent code sets it.  Storage for any data
  281.      pointed to by this field should be allocated on the symbol_obstack for
  282.      the associated objfile.  The type would be "void *" except for reasons
  283.      of compatibility with older compilers.  This field is optional. */
  284.  
  285.   char *info;
  286.  
  287.   /* Classification types for this symbol.  These should be taken as "advisory
  288.      only", since if gdb can't easily figure out a classification it simply
  289.      selects mst_unknown.  It may also have to guess when it can't figure out
  290.      which is a better match between two types (mst_data versus mst_bss) for
  291.      example.  Since the minimal symbol info is sometimes derived from the
  292.      BFD library's view of a file, we need to live with what information bfd
  293.      supplies. */
  294.  
  295.   enum minimal_symbol_type
  296.     {
  297.       mst_unknown = 0,        /* Unknown type, the default */
  298.       mst_text,            /* Generally executable instructions */
  299.       mst_data,            /* Generally initialized data */
  300.       mst_bss,            /* Generally uninitialized data */
  301.       mst_abs,            /* Generally absolute (nonrelocatable) */
  302.       /* For the mst_file* types, the names are only guaranteed to be unique
  303.      within a given .o file.  */
  304.       mst_file_text,        /* Static version of mst_text */
  305.       mst_file_data,        /* Static version of mst_data */
  306.       mst_file_bss        /* Static version of mst_bss */
  307.     } type BYTE_BITFIELD;
  308.  
  309. };
  310.  
  311. #define MSYMBOL_INFO(msymbol)        (msymbol)->info
  312. #define MSYMBOL_TYPE(msymbol)        (msymbol)->type
  313.  
  314.  
  315. /* All of the name-scope contours of the program
  316.    are represented by `struct block' objects.
  317.    All of these objects are pointed to by the blockvector.
  318.  
  319.    Each block represents one name scope.
  320.    Each lexical context has its own block.
  321.  
  322.    The blockvector begins with some special blocks.
  323.    The GLOBAL_BLOCK contains all the symbols defined in this compilation
  324.    whose scope is the entire program linked together.
  325.    The STATIC_BLOCK contains all the symbols whose scope is the
  326.    entire compilation excluding other separate compilations.
  327.    Blocks starting with the FIRST_LOCAL_BLOCK are not special.
  328.  
  329.    Each block records a range of core addresses for the code that
  330.    is in the scope of the block.  The STATIC_BLOCK and GLOBAL_BLOCK
  331.    give, for the range of code, the entire range of code produced
  332.    by the compilation that the symbol segment belongs to.
  333.  
  334.    The blocks appear in the blockvector
  335.    in order of increasing starting-address,
  336.    and, within that, in order of decreasing ending-address.
  337.  
  338.    This implies that within the body of one function
  339.    the blocks appear in the order of a depth-first tree walk.  */
  340.  
  341. struct blockvector
  342. {
  343.   /* Number of blocks in the list.  */
  344.   int nblocks;
  345.   /* The blocks themselves.  */
  346.   struct block *block[1];
  347. };
  348.  
  349. #define BLOCKVECTOR_NBLOCKS(blocklist) (blocklist)->nblocks
  350. #define BLOCKVECTOR_BLOCK(blocklist,n) (blocklist)->block[n]
  351.  
  352. /* Special block numbers */
  353.  
  354. #define GLOBAL_BLOCK        0
  355. #define    STATIC_BLOCK        1
  356. #define    FIRST_LOCAL_BLOCK    2
  357.  
  358. struct block
  359. {
  360.  
  361.   /* Addresses in the executable code that are in this block.  */
  362.  
  363.   CORE_ADDR startaddr;
  364.   CORE_ADDR endaddr;
  365.  
  366.   /* The symbol that names this block, if the block is the body of a
  367.      function; otherwise, zero.  */
  368.  
  369.   struct symbol *function;
  370.  
  371.   /* The `struct block' for the containing block, or 0 if none.
  372.  
  373.      The superblock of a top-level local block (i.e. a function in the
  374.      case of C) is the STATIC_BLOCK.  The superblock of the
  375.      STATIC_BLOCK is the GLOBAL_BLOCK.  */
  376.  
  377.   struct block *superblock;
  378.  
  379.   /* Version of GCC used to compile the function corresponding
  380.      to this block, or 0 if not compiled with GCC.  When possible,
  381.      GCC should be compatible with the native compiler, or if that
  382.      is not feasible, the differences should be fixed during symbol
  383.      reading.  As of 16 Apr 93, this flag is never used to distinguish
  384.      between gcc2 and the native compiler.
  385.  
  386.      If there is no function corresponding to this block, this meaning
  387.      of this flag is undefined.  */
  388.  
  389.   unsigned char gcc_compile_flag;
  390.  
  391.   /* Number of local symbols.  */
  392.  
  393.   int nsyms;
  394.  
  395.   /* The symbols.  If some of them are arguments, then they must be
  396.      in the order in which we would like to print them.  */
  397.  
  398.   struct symbol *sym[1];
  399. };
  400.  
  401. #define BLOCK_START(bl)        (bl)->startaddr
  402. #define BLOCK_END(bl)        (bl)->endaddr
  403. #define BLOCK_NSYMS(bl)        (bl)->nsyms
  404. #define BLOCK_SYM(bl, n)    (bl)->sym[n]
  405. #define BLOCK_FUNCTION(bl)    (bl)->function
  406. #define BLOCK_SUPERBLOCK(bl)    (bl)->superblock
  407. #define BLOCK_GCC_COMPILED(bl)    (bl)->gcc_compile_flag
  408.  
  409. /* Nonzero if symbols of block BL should be sorted alphabetically.
  410.    Don't sort a block which corresponds to a function.  If we did the
  411.    sorting would have to preserve the order of the symbols for the
  412.    arguments.  */
  413.  
  414. #define BLOCK_SHOULD_SORT(bl) ((bl)->nsyms >= 40 && BLOCK_FUNCTION (bl) == NULL)
  415.  
  416.  
  417. /* Represent one symbol name; a variable, constant, function or typedef.  */
  418.  
  419. /* Different name spaces for symbols.  Looking up a symbol specifies a
  420.    namespace and ignores symbol definitions in other name spaces. */
  421.  
  422. enum namespace
  423. {
  424.   /* UNDEF_NAMESPACE is used when a namespace has not been discovered or
  425.      none of the following apply.  This usually indicates an error either
  426.      in the symbol information or in gdb's handling of symbols. */
  427.  
  428.   UNDEF_NAMESPACE,
  429.  
  430.   /* VAR_NAMESPACE is the usual namespace.  In C, this contains variables,
  431.      function names, typedef names and enum type values. */
  432.  
  433.   VAR_NAMESPACE,
  434.  
  435.   /* STRUCT_NAMESPACE is used in C to hold struct, union and enum type names.
  436.      Thus, if `struct foo' is used in a C program, it produces a symbol named
  437.      `foo' in the STRUCT_NAMESPACE. */
  438.  
  439.   STRUCT_NAMESPACE,
  440.  
  441.   /* LABEL_NAMESPACE may be used for names of labels (for gotos);
  442.      currently it is not used and labels are not recorded at all.  */
  443.  
  444.   LABEL_NAMESPACE
  445. };
  446.  
  447. /* An address-class says where to find the value of a symbol.  */
  448.  
  449. enum address_class
  450. {
  451.   /* Not used; catches errors */
  452.  
  453.   LOC_UNDEF,
  454.  
  455.   /* Value is constant int SYMBOL_VALUE, host byteorder */
  456.  
  457.   LOC_CONST,
  458.  
  459.   /* Value is at fixed address SYMBOL_VALUE_ADDRESS */
  460.  
  461.   LOC_STATIC,
  462.  
  463.   /* Value is in register.  SYMBOL_VALUE is the register number.  */
  464.  
  465.   LOC_REGISTER,
  466.  
  467.   /* It's an argument; the value is at SYMBOL_VALUE offset in arglist.  */
  468.  
  469.   LOC_ARG,
  470.  
  471.   /* Value address is at SYMBOL_VALUE offset in arglist.  */
  472.  
  473.   LOC_REF_ARG,
  474.  
  475.   /* Value is in register number SYMBOL_VALUE.  Just like LOC_REGISTER
  476.      except this is an argument.  Probably the cleaner way to handle
  477.      this would be to separate address_class (which would include
  478.      separate ARG and LOCAL to deal with FRAME_ARGS_ADDRESS versus
  479.      FRAME_LOCALS_ADDRESS), and an is_argument flag.
  480.  
  481.      For some symbol formats (stabs, for some compilers at least),
  482.      the compiler generates two symbols, an argument and a register.
  483.      In some cases we combine them to a single LOC_REGPARM in symbol
  484.      reading, but currently not for all cases (e.g. it's passed on the
  485.      stack and then loaded into a register).  */
  486.  
  487.   LOC_REGPARM,
  488.  
  489.   /* Value is in specified register.  Just like LOC_REGPARM except the
  490.      register holds the address of the argument instead of the argument
  491.      itself. This is currently used for the passing of structs and unions
  492.      on sparc and hppa.  It is also used for call by reference where the
  493.      address is in a register, at least by mipsread.c.  */
  494.  
  495.   LOC_REGPARM_ADDR,
  496.  
  497.   /* Value is a local variable at SYMBOL_VALUE offset in stack frame.  */
  498.  
  499.   LOC_LOCAL,
  500.  
  501.   /* Value not used; definition in SYMBOL_TYPE.  Symbols in the namespace
  502.      STRUCT_NAMESPACE all have this class.  */
  503.  
  504.   LOC_TYPEDEF,
  505.  
  506.   /* Value is address SYMBOL_VALUE_ADDRESS in the code */
  507.  
  508.   LOC_LABEL,
  509.  
  510.   /* In a symbol table, value is SYMBOL_BLOCK_VALUE of a `struct block'.
  511.      In a partial symbol table, SYMBOL_VALUE_ADDRESS is the start address
  512.      of the block.  Function names have this class. */
  513.  
  514.   LOC_BLOCK,
  515.  
  516.   /* Value is a constant byte-sequence pointed to by SYMBOL_VALUE_BYTES, in
  517.      target byte order.  */
  518.  
  519.   LOC_CONST_BYTES,
  520.  
  521.   /* Value is arg at SYMBOL_VALUE offset in stack frame. Differs from
  522.      LOC_LOCAL in that symbol is an argument; differs from LOC_ARG in
  523.      that we find it in the frame (FRAME_LOCALS_ADDRESS), not in the
  524.      arglist (FRAME_ARGS_ADDRESS).  Added for i960, which passes args
  525.      in regs then copies to frame.  */
  526.  
  527.   LOC_LOCAL_ARG,
  528.  
  529.   /* Value is at SYMBOL_VALUE offset from the current value of
  530.      register number SYMBOL_BASEREG.  This exists mainly for the same
  531.      things that LOC_LOCAL and LOC_ARG do; but we need to do this
  532.      instead because on 88k DWARF gives us the offset from the
  533.      frame/stack pointer, rather than the offset from the "canonical
  534.      frame address" used by COFF, stabs, etc., and we don't know how
  535.      to convert between these until we start examining prologues.
  536.  
  537.      Note that LOC_BASEREG is much less general than a DWARF expression.
  538.      We don't need the generality (at least not yet), and storing a general
  539.      DWARF expression would presumably take up more space than the existing
  540.      scheme.  */
  541.  
  542.   LOC_BASEREG,
  543.  
  544.   /* Same as LOC_BASEREG but it is an argument.  */
  545.  
  546.   LOC_BASEREG_ARG,
  547.  
  548.   /* The variable does not actually exist in the program.
  549.      The value is ignored.  */
  550.  
  551.   LOC_OPTIMIZED_OUT
  552. };
  553.  
  554. struct symbol
  555. {
  556.  
  557.   /* The general symbol info required for all types of symbols. */
  558.  
  559.   struct general_symbol_info ginfo;
  560.  
  561.   /* Data type of value */
  562.  
  563.   struct type *type;
  564.  
  565.   /* Name space code.  */
  566.  
  567.   enum namespace namespace BYTE_BITFIELD;
  568.  
  569.   /* Address class */
  570.  
  571.   enum address_class class BYTE_BITFIELD;
  572.  
  573.   /* Line number of definition.  FIXME:  Should we really make the assumption
  574.      that nobody will try to debug files longer than 64K lines?  What about
  575.      machine generated programs? */
  576.  
  577.   unsigned short line;
  578.   
  579.   /* Some symbols require an additional value to be recorded on a per-
  580.      symbol basis.  Stash those values here. */
  581.  
  582.   union
  583.     {
  584.       /* Used by LOC_BASEREG and LOC_BASEREG_ARG.  */
  585.       short basereg;
  586.     }
  587.   aux_value;
  588. };
  589.  
  590. #define SYMBOL_NAMESPACE(symbol)    (symbol)->namespace
  591. #define SYMBOL_CLASS(symbol)        (symbol)->class
  592. #define SYMBOL_TYPE(symbol)        (symbol)->type
  593. #define SYMBOL_LINE(symbol)        (symbol)->line
  594. #define SYMBOL_BASEREG(symbol)        (symbol)->aux_value.basereg
  595.  
  596. /* A partial_symbol records the name, namespace, and address class of
  597.    symbols whose types we have not parsed yet.  For functions, it also
  598.    contains their memory address, so we can find them from a PC value.
  599.    Each partial_symbol sits in a partial_symtab, all of which are chained
  600.    on a  partial symtab list and which points to the corresponding 
  601.    normal symtab once the partial_symtab has been referenced.  */
  602.  
  603. struct partial_symbol
  604. {
  605.  
  606.   /* The general symbol info required for all types of symbols. */
  607.  
  608.   struct general_symbol_info ginfo;
  609.  
  610.   /* Name space code.  */
  611.  
  612.   enum namespace namespace BYTE_BITFIELD;
  613.  
  614.   /* Address class (for info_symbols) */
  615.  
  616.   enum address_class class BYTE_BITFIELD;
  617.  
  618. };
  619.  
  620. #define PSYMBOL_NAMESPACE(psymbol)    (psymbol)->namespace
  621. #define PSYMBOL_CLASS(psymbol)        (psymbol)->class
  622.  
  623.  
  624. /* Source-file information.  This describes the relation between source files,
  625.    ine numbers and addresses in the program text.  */
  626.  
  627. struct sourcevector
  628. {
  629.   int length;            /* Number of source files described */
  630.   struct source *source[1];    /* Descriptions of the files */
  631. };
  632.  
  633. /* Each item represents a line-->pc (or the reverse) mapping.  This is
  634.    somewhat more wasteful of space than one might wish, but since only
  635.    the files which are actually debugged are read in to core, we don't
  636.    waste much space.  */
  637.  
  638. struct linetable_entry
  639. {
  640.   int line;
  641.   CORE_ADDR pc;
  642. };
  643.  
  644. /* The order of entries in the linetable is significant.  They should
  645.    be sorted by increasing values of the pc field.  If there is more than
  646.    one entry for a given pc, then I'm not sure what should happen (and
  647.    I not sure whether we currently handle it the best way).
  648.  
  649.    Example: a C for statement generally looks like this
  650.  
  651.        10    0x100    - for the init/test part of a for stmt.
  652.        20    0x200
  653.        30    0x300
  654.        10    0x400    - for the increment part of a for stmt.
  655.  
  656.    */
  657.  
  658. struct linetable
  659. {
  660.   int nitems;
  661.  
  662.   /* Actually NITEMS elements.  If you don't like this use of the
  663.      `struct hack', you can shove it up your ANSI (seriously, if the
  664.      committee tells us how to do it, we can probably go along).  */
  665.   struct linetable_entry item[1];
  666. };
  667.  
  668. /* All the information on one source file.  */
  669.  
  670. struct source
  671. {
  672.   char *name;            /* Name of file */
  673.   struct linetable contents;
  674. };
  675.  
  676. /* How to relocate the symbols from each section in a symbol file.
  677.    Each struct contains an array of offsets.
  678.    The ordering and meaning of the offsets is file-type-dependent;
  679.    typically it is indexed by section numbers or symbol types or
  680.    something like that.
  681.  
  682.    To give us flexibility in changing the internal representation
  683.    of these offsets, the ANOFFSET macro must be used to insert and
  684.    extract offset values in the struct.  */
  685.  
  686. struct section_offsets
  687.   {
  688.     CORE_ADDR offsets[1];        /* As many as needed. */
  689.   };
  690.  
  691. #define    ANOFFSET(secoff, whichone)    (secoff->offsets[whichone])
  692.  
  693. /* Each source file or header is represented by a struct symtab. 
  694.    These objects are chained through the `next' field.  */
  695.  
  696. struct symtab
  697.   {
  698.  
  699.     /* Chain of all existing symtabs.  */
  700.  
  701.     struct symtab *next;
  702.  
  703.     /* List of all symbol scope blocks for this symtab.  May be shared
  704.        between different symtabs (and normally is for all the symtabs
  705.        in a given compilation unit).  */
  706.  
  707.     struct blockvector *blockvector;
  708.  
  709.     /* Table mapping core addresses to line numbers for this file.
  710.        Can be NULL if none.  Never shared between different symtabs.  */
  711.  
  712.     struct linetable *linetable;
  713.  
  714.     /* Section in objfile->section_offsets for the blockvector and
  715.        the linetable.  */
  716.  
  717.     int block_line_section;
  718.  
  719.     /* If several symtabs share a blockvector, exactly one of them
  720.        should be designed the primary, so that the blockvector
  721.        is relocated exactly once by objfile_relocate.  */
  722.  
  723.     int primary;
  724.  
  725.     /* Name of this source file.  */
  726.  
  727.     char *filename;
  728.  
  729.     /* Directory in which it was compiled, or NULL if we don't know.  */
  730.  
  731.     char *dirname;
  732.  
  733.     /* This component says how to free the data we point to:
  734.        free_contents => do a tree walk and free each object.
  735.        free_nothing => do nothing; some other symtab will free
  736.          the data this one uses.
  737.       free_linetable => free just the linetable.  FIXME: Is this redundant
  738.       with the primary field?  */
  739.  
  740.     enum free_code
  741.       {
  742.     free_nothing, free_contents, free_linetable
  743.     }
  744.     free_code;
  745.  
  746.     /* Pointer to one block of storage to be freed, if nonzero.  */
  747.     /* This is IN ADDITION to the action indicated by free_code.  */
  748.     
  749.     char *free_ptr;
  750.  
  751.     /* Total number of lines found in source file.  */
  752.  
  753.     int nlines;
  754.  
  755.     /* line_charpos[N] is the position of the (N-1)th line of the
  756.        source file.  "position" means something we can lseek() to; it
  757.        is not guaranteed to be useful any other way.  */
  758.  
  759.     int *line_charpos;
  760.  
  761.     /* Language of this source file.  */
  762.  
  763.     enum language language;
  764.  
  765.     /* String of version information.  May be zero.  */
  766.  
  767.     char *version;
  768.  
  769.     /* Full name of file as found by searching the source path.
  770.        NULL if not yet known.  */
  771.  
  772.     char *fullname;
  773.  
  774.     /* Object file from which this symbol information was read.  */
  775.  
  776.     struct objfile *objfile;
  777.  
  778.     /* Anything extra for this symtab.  This is for target machines
  779.        with special debugging info of some sort (which cannot just
  780.        be represented in a normal symtab).  */
  781.  
  782. #if defined (EXTRA_SYMTAB_INFO)
  783.     EXTRA_SYMTAB_INFO
  784. #endif
  785.  
  786.   };
  787.  
  788. #define BLOCKVECTOR(symtab)    (symtab)->blockvector
  789. #define LINETABLE(symtab)    (symtab)->linetable
  790.  
  791.  
  792. /* Each source file that has not been fully read in is represented by
  793.    a partial_symtab.  This contains the information on where in the
  794.    executable the debugging symbols for a specific file are, and a
  795.    list of names of global symbols which are located in this file.
  796.    They are all chained on partial symtab lists.
  797.  
  798.    Even after the source file has been read into a symtab, the
  799.    partial_symtab remains around.  They are allocated on an obstack,
  800.    psymbol_obstack.  FIXME, this is bad for dynamic linking or VxWorks-
  801.    style execution of a bunch of .o's.  */
  802.  
  803. struct partial_symtab
  804. {
  805.  
  806.   /* Chain of all existing partial symtabs.  */
  807.  
  808.   struct partial_symtab *next;
  809.  
  810.   /* Name of the source file which this partial_symtab defines */
  811.  
  812.   char *filename;
  813.  
  814.   /* Information about the object file from which symbols should be read.  */
  815.  
  816.   struct objfile *objfile;
  817.  
  818.   /* Set of relocation offsets to apply to each section.  */ 
  819.  
  820.   struct section_offsets *section_offsets;
  821.  
  822.   /* Range of text addresses covered by this file; texthigh is the
  823.      beginning of the next section. */
  824.  
  825.   CORE_ADDR textlow;
  826.   CORE_ADDR texthigh;
  827.  
  828.   /* Array of pointers to all of the partial_symtab's which this one
  829.      depends on.  Since this array can only be set to previous or
  830.      the current (?) psymtab, this dependency tree is guaranteed not
  831.      to have any loops.  "depends on" means that symbols must be read
  832.      for the dependencies before being read for this psymtab; this is
  833.      for type references in stabs, where if foo.c includes foo.h, declarations
  834.      in foo.h may use type numbers defined in foo.c.  For other debugging
  835.      formats there may be no need to use dependencies.  */
  836.  
  837.   struct partial_symtab **dependencies;
  838.  
  839.   int number_of_dependencies;
  840.  
  841.   /* Global symbol list.  This list will be sorted after readin to
  842.      improve access.  Binary search will be the usual method of
  843.      finding a symbol within it. globals_offset is an integer offset
  844.      within global_psymbols[].  */
  845.  
  846.   int globals_offset;
  847.   int n_global_syms;
  848.  
  849.   /* Static symbol list.  This list will *not* be sorted after readin;
  850.      to find a symbol in it, exhaustive search must be used.  This is
  851.      reasonable because searches through this list will eventually
  852.      lead to either the read in of a files symbols for real (assumed
  853.      to take a *lot* of time; check) or an error (and we don't care
  854.      how long errors take).  This is an offset and size within
  855.      static_psymbols[].  */
  856.  
  857.   int statics_offset;
  858.   int n_static_syms;
  859.  
  860.   /* Pointer to symtab eventually allocated for this source file, 0 if
  861.      !readin or if we haven't looked for the symtab after it was readin.  */
  862.  
  863.   struct symtab *symtab;
  864.  
  865.   /* Pointer to function which will read in the symtab corresponding to
  866.      this psymtab.  */
  867.  
  868.   void (*read_symtab) PARAMS ((struct partial_symtab *));
  869.  
  870.   /* Information that lets read_symtab() locate the part of the symbol table
  871.      that this psymtab corresponds to.  This information is private to the
  872.      format-dependent symbol reading routines.  For further detail examine
  873.      the various symbol reading modules.  Should really be (void *) but is
  874.      (char *) as with other such gdb variables.  (FIXME) */
  875.  
  876.   char *read_symtab_private;
  877.  
  878.   /* Non-zero if the symtab corresponding to this psymtab has been readin */
  879.  
  880.   unsigned char readin;
  881. };
  882.  
  883. /* A fast way to get from a psymtab to its symtab (after the first time).  */
  884. #define    PSYMTAB_TO_SYMTAB(pst)  \
  885.     ((pst) -> symtab != NULL ? (pst) -> symtab : psymtab_to_symtab (pst))
  886.  
  887.  
  888. /* The virtual function table is now an array of structures which have the
  889.    form { int16 offset, delta; void *pfn; }. 
  890.  
  891.    In normal virtual function tables, OFFSET is unused.
  892.    DELTA is the amount which is added to the apparent object's base
  893.    address in order to point to the actual object to which the
  894.    virtual function should be applied.
  895.    PFN is a pointer to the virtual function.
  896.  
  897.    Note that this macro is g++ specific (FIXME). */
  898.   
  899. #define VTBL_FNADDR_OFFSET 2
  900.  
  901. /* Macro that yields non-zero value iff NAME is the prefix for C++ operator
  902.    names.  If you leave out the parenthesis here you will lose!
  903.    Currently 'o' 'p' CPLUS_MARKER is used for both the symbol in the
  904.    symbol-file and the names in gdb's symbol table.
  905.    Note that this macro is g++ specific (FIXME). */
  906.  
  907. #define OPNAME_PREFIX_P(NAME) \
  908.   ((NAME)[0] == 'o' && (NAME)[1] == 'p' && (NAME)[2] == CPLUS_MARKER)
  909.  
  910. /* Macro that yields non-zero value iff NAME is the prefix for C++ vtbl
  911.    names.  Note that this macro is g++ specific (FIXME).  */
  912.  
  913. #define VTBL_PREFIX_P(NAME) \
  914.   ((NAME)[3] == CPLUS_MARKER && !strncmp ((NAME), "_vt", 3))
  915.  
  916. /* Macro that yields non-zero value iff NAME is the prefix for C++ destructor
  917.    names.  Note that this macro is g++ specific (FIXME).  */
  918.  
  919. #define DESTRUCTOR_PREFIX_P(NAME) \
  920.   ((NAME)[0] == '_' && (NAME)[1] == CPLUS_MARKER && (NAME)[2] == '_')
  921.  
  922.  
  923. /* External variables and functions for the objects described above. */
  924.  
  925. /* This symtab variable specifies the current file for printing source lines */
  926.  
  927. extern struct symtab *current_source_symtab;
  928.  
  929. /* This is the next line to print for listing source lines.  */
  930.  
  931. extern int current_source_line;
  932.  
  933. /* See the comment in symfile.c about how current_objfile is used. */
  934.  
  935. extern struct objfile *current_objfile;
  936.  
  937. extern struct symtab *
  938. lookup_symtab PARAMS ((char *));
  939.  
  940. extern struct symbol *
  941. lookup_symbol PARAMS ((const char *, const struct block *,
  942.                const enum namespace, int *, struct symtab **));
  943.  
  944. extern struct symbol *
  945. lookup_block_symbol PARAMS ((const struct block *, const char *,
  946.                  const enum namespace));
  947.  
  948. extern struct type *
  949. lookup_struct PARAMS ((char *, struct block *));
  950.  
  951. extern struct type *
  952. lookup_union PARAMS ((char *, struct block *));
  953.  
  954. extern struct type *
  955. lookup_enum PARAMS ((char *, struct block *));
  956.  
  957. extern struct symbol *
  958. block_function PARAMS ((struct block *));
  959.  
  960. extern struct symbol *
  961. find_pc_function PARAMS ((CORE_ADDR));
  962.  
  963. extern int find_pc_partial_function
  964.   PARAMS ((CORE_ADDR, char **, CORE_ADDR *, CORE_ADDR *));
  965.  
  966. extern void
  967. clear_pc_function_cache PARAMS ((void));
  968.  
  969. extern struct partial_symtab *
  970. lookup_partial_symtab PARAMS ((char *));
  971.  
  972. extern struct partial_symtab *
  973. find_pc_psymtab PARAMS ((CORE_ADDR));
  974.  
  975. extern struct symtab *
  976. find_pc_symtab PARAMS ((CORE_ADDR));
  977.  
  978. extern struct partial_symbol *
  979. find_pc_psymbol PARAMS ((struct partial_symtab *, CORE_ADDR));
  980.  
  981. extern int
  982. find_pc_line_pc_range PARAMS ((CORE_ADDR, CORE_ADDR *, CORE_ADDR *));
  983.  
  984. extern int
  985. contained_in PARAMS ((struct block *, struct block *));
  986.  
  987. extern void
  988. reread_symbols PARAMS ((void));
  989.  
  990. /* Macro for name of symbol to indicate a file compiled with gcc. */
  991. #ifndef GCC_COMPILED_FLAG_SYMBOL
  992. #define GCC_COMPILED_FLAG_SYMBOL "gcc_compiled."
  993. #endif
  994.  
  995. /* Macro for name of symbol to indicate a file compiled with gcc2. */
  996. #ifndef GCC2_COMPILED_FLAG_SYMBOL
  997. #define GCC2_COMPILED_FLAG_SYMBOL "gcc2_compiled."
  998. #endif
  999.  
  1000. /* Functions for dealing with the minimal symbol table, really a misc
  1001.    address<->symbol mapping for things we don't have debug symbols for.  */
  1002.  
  1003. extern void prim_record_minimal_symbol PARAMS ((const char *, CORE_ADDR,
  1004.                         enum minimal_symbol_type,
  1005.                         struct objfile *));
  1006.  
  1007. extern void prim_record_minimal_symbol_and_info
  1008.   PARAMS ((const char *, CORE_ADDR,
  1009.        enum minimal_symbol_type,
  1010.        char *info, int section,
  1011.        struct objfile *));
  1012.  
  1013. extern struct minimal_symbol *
  1014. lookup_minimal_symbol PARAMS ((const char *, struct objfile *));
  1015.  
  1016. extern struct minimal_symbol *
  1017. lookup_minimal_symbol_by_pc PARAMS ((CORE_ADDR));
  1018.  
  1019. extern void
  1020. init_minimal_symbol_collection PARAMS ((void));
  1021.  
  1022. extern void
  1023. discard_minimal_symbols PARAMS ((int));
  1024.  
  1025. extern void
  1026. install_minimal_symbols PARAMS ((struct objfile *));
  1027.  
  1028. struct symtab_and_line
  1029. {
  1030.   struct symtab *symtab;
  1031.  
  1032.   /* Line number.  Line numbers start at 1 and proceed through symtab->nlines.
  1033.      0 is never a valid line number; it is used to indicate that line number
  1034.      information is not available.  */
  1035.   int line;
  1036.  
  1037.   CORE_ADDR pc;
  1038.   CORE_ADDR end;
  1039. };
  1040.  
  1041. struct symtabs_and_lines
  1042. {
  1043.   struct symtab_and_line *sals;
  1044.   int nelts;
  1045. };
  1046.  
  1047. /* Given a pc value, return line number it is in.  Second arg nonzero means
  1048.    if pc is on the boundary use the previous statement's line number.  */
  1049.  
  1050. extern struct symtab_and_line
  1051. find_pc_line PARAMS ((CORE_ADDR, int));
  1052.  
  1053. /* Given an address, return the nearest symbol at or below it in memory.
  1054.    Optionally return the symtab it's from through 2nd arg, and the
  1055.    address in inferior memory of the symbol through 3rd arg.  */
  1056.  
  1057. extern struct symbol *
  1058. find_addr_symbol PARAMS ((CORE_ADDR, struct symtab **, CORE_ADDR *));
  1059.  
  1060. /* Given a symtab and line number, return the pc there.  */
  1061.  
  1062. extern CORE_ADDR
  1063. find_line_pc PARAMS ((struct symtab *, int));
  1064.  
  1065. extern int 
  1066. find_line_pc_range PARAMS ((struct symtab_and_line,
  1067.                 CORE_ADDR *, CORE_ADDR *));
  1068.  
  1069. extern void
  1070. resolve_sal_pc PARAMS ((struct symtab_and_line *));
  1071.  
  1072. /* Given a string, return the line specified by it.  For commands like "list"
  1073.    and "breakpoint".  */
  1074.  
  1075. extern struct symtabs_and_lines
  1076. decode_line_spec PARAMS ((char *, int));
  1077.  
  1078. extern struct symtabs_and_lines
  1079. decode_line_spec_1 PARAMS ((char *, int));
  1080.  
  1081. extern struct symtabs_and_lines
  1082. decode_line_1 PARAMS ((char **, int, struct symtab *, int, char ***));
  1083.  
  1084. /* Symmisc.c */
  1085.  
  1086. #if MAINTENANCE_CMDS
  1087.  
  1088. void
  1089. maintenance_print_symbols PARAMS ((char *, int));
  1090.  
  1091. void
  1092. maintenance_print_psymbols PARAMS ((char *, int));
  1093.  
  1094. void
  1095. maintenance_print_msymbols PARAMS ((char *, int));
  1096.  
  1097. void
  1098. maintenance_print_objfiles PARAMS ((char *, int));
  1099.  
  1100. #endif
  1101.  
  1102. extern void
  1103. free_symtab PARAMS ((struct symtab *));
  1104.  
  1105. /* Symbol-reading stuff in symfile.c and solib.c.  */
  1106.  
  1107. extern struct symtab *
  1108. psymtab_to_symtab PARAMS ((struct partial_symtab *));
  1109.  
  1110. extern void
  1111. clear_solib PARAMS ((void));
  1112.  
  1113. extern struct objfile *
  1114. symbol_file_add PARAMS ((char *, int, CORE_ADDR, int, int, int));
  1115.  
  1116. /* source.c */
  1117.  
  1118. extern int frame_file_full_name; /* in stack.c */
  1119.  
  1120. extern int
  1121. identify_source_line PARAMS ((struct symtab *, int, int, CORE_ADDR));
  1122.  
  1123. extern void
  1124. print_source_lines PARAMS ((struct symtab *, int, int, int));
  1125.  
  1126. extern void
  1127. forget_cached_source_info PARAMS ((void));
  1128.  
  1129. extern void
  1130. select_source_symtab PARAMS ((struct symtab *));
  1131.  
  1132. extern char **make_symbol_completion_list PARAMS ((char *, char *));
  1133.  
  1134. /* symtab.c */
  1135.  
  1136. extern struct partial_symtab *
  1137. find_main_psymtab PARAMS ((void));
  1138.  
  1139. /* blockframe.c */
  1140.  
  1141. extern struct blockvector *
  1142. blockvector_for_pc PARAMS ((CORE_ADDR, int *));
  1143.  
  1144. /* symfile.c */
  1145.  
  1146. extern void
  1147. clear_symtab_users PARAMS ((void));
  1148.  
  1149. extern enum language
  1150. deduce_language_from_filename PARAMS ((char *));
  1151.  
  1152. #endif /* !defined(SYMTAB_H) */
  1153.